]> dgit.raspbian.org Git - gnome-shell.git/commitdiff
doc: Link to GNOME handbook tutorial for toolbox development
authorsorelz <sorelz.zen498@passinbox.com>
Sun, 21 Jul 2024 19:58:22 +0000 (15:58 -0400)
committerSarah Macdonald <sorelz.zen498@passinbox.com>
Tue, 30 Jul 2024 16:44:40 +0000 (12:44 -0400)
Link gnome-shell's toolbox README to the troubleshooting section
of the toolbox page at handbook.gnome.org, to make it easier to
find information on common toolbox development issues.

Closes: https://gitlab.gnome.org/GNOME/gnome-shell/-/issues/7598
Part-of: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/3424>

tools/toolbox/README.md

index bf7e83de13a1d686054fe13670012e1a91cd767e..3b695db2da8736a855fc30aff9e13d5519ead731 100644 (file)
@@ -7,6 +7,8 @@ install software on the host.
 It is suitable for gnome-shell development, and we maintain a number of scripts
 to make its use easier and more convenient.
 
+When things go wrong, please check out the [troubleshooting section][troubleshooting] in the [GNOME Project Handbook][handbook].
+
 ## create-toolbox.sh
 Create a new toolbox for gnome-shell development.
 
@@ -59,3 +61,5 @@ Run the script with `--help` to see all available options.
 [mutter]: https://gitlab.gnome.org/GNOME/mutter
 [builder]: https://apps.gnome.org/Builder/
 [meson]: https://mesonbuild.com
+[handbook]: https://handbook.gnome.org/
+[troubleshooting]: https://handbook.gnome.org/development/toolbx.html#when-things-go-wrong